Skip Headers

Oracle® Universal Installer and OPatch User's Guide 10g Release 2 (10.2) for Windows and UNIX Part Number B16227-02 |
Home | Book List | Contents | Index | Master Index | Feedback

Previous | Next
| View PDF

# C Understanding Oracle Universal Installer Commands

The Oracle Universal Installer is run with various options and command-line arguments. This appendix lists the syntax of Oracle Universal Installer, the various command line options available in Oracle Universal Installer. The following command shows the syntax for running the Oracle Universal Installer:

    ./runInstaller or setup.exe <option> [-command_line_variable=value]

In the preceding command, the following variables are used:

- option: The options available in Oracle Universal Installer. They are described in Table C-1, "Options in Oracle Universal Installer".

- command_line_variable: The command-line variable for the option. They are described in Table C-2, "Command line variables in Oracle Universal Installer".

  Note: You can pass the command line variable in either of the following three ways: <command_line_variable>={"value1","value2"} "<command_line_variable>={value1,value2}" <command_line_variable>="{value1,value2}"

## Options Available in Oracle Universal Installer

The following table lists the various options available in Oracle Universal Installer:

Table C-1 Options in Oracle Universal Installer

Option | Description
--- | ---
-clusterware oracle.crs,<crs version> | This is the version of the Oracle Clusterware installed.
-crsLocation <Path> | This specifies the path to the Oracle Clusterware home location. This flag is used only for cluster installs. Specifying this flag overrides the CRS information obtained from the Central Inventory.
-invPtrLoc <full path of oraInst.loc> | This is used to point to a different inventory location. The orainst.loc file contains the following entries:inventory_loc=<location of central inventory>inst_group=<> This flag can only be passed on UNIX platforms.
-jreLoc <location> | This is the path where the Java Runtime Environment is installed. You need to mention this path to override the default path.
-logLevel <level> | This is used to filter log messages that have a lesser priority level than the level specified. Valid options are: severe, warning, info, config, fine, finer, and finest.
-paramFile <location of file> | This is used to specify the location of oraparam.ini file to be used by Oracle Universal Installer.
-responseFile <Path> | This is used to specify the location of the response file to use. This option is used with the -silent flag.
-sourceLoc <location of products.xml> | This is used to specify the ship home location.
-addLangs | This is used to add new languages to an already installed product.
-addNode | This is used for adding node(s) to the installation. You cannot use this flag in silent mode with response files. You can pass the required session variable through the command line. You must pass the CLUSTER_NEW_NODES, CLUSTER_NEW_PRIVATE_NODE_NAMES, and CLUSTER_NEW_VIRTUAL_HOSTNAMES session variables when using this flag.
-attachHome | This is used for attaching homes to the Oracle Universal Installer inventory. You must pass the ORACLE_HOME and ORACLE_HOME_NAME session variables when using this flag.
-cfs | This is used to indicate that the Oracle home specified is on cluster file system (shared). This is mandatory when '-local' flag is specified so that Oracle Universal Installer can register the home appropriately into the inventory.
-clone | This is used for cloning an Oracle home from a source location to a target location. You must pass the ORACLE_HOME and ORACLE_HOME_NAME session variables when using this flag.
-debug | This is used for getting the debug information from Oracle Universal Installer.
-deinstall | This flag is used for de-install operations. You can pass the DEINSTALL_LIST and/or REMOVE_HOMES along with ORACLE_HOME and/or ORACLE_HOME_NAME session variables when using this flag
-detachHome | This flag is used for detaching homes from the Oracle Universal Installer inventory without deleting the inventory directory inside the Oracle home. You must pass the ORACLE_HOME session variable when using this flag.
-enableRollingUpgrade | This is used in cluster environments, to enable an upgrade of a product on a subset of nodes (on which the product was installed).
-executeSysPrereqs | This is used to execute system pre-requisite checks and exit.
-force | This allows silent mode installation on a non-empty directory without warning.
-help | This is used to list the syntax and help information.
-ignorePatchConflicts | This is used to ignore all conflicts with existing interim patches during an upgrade. The conflicting interim patches are removed from the home.
-ignoreSysPrereqs | This flag is used for ignoring the results of the system pre-requisite checks.
-local | This performs the specified operation on the local node irrespective of the cluster nodes specified.
-printdiskusage | This is used for logging debug information for disk usage.
-printmemory | This is used for logging debug information for memory usage.
-printtime | This is used for logging debug information for time usage.
-record -destinationFile <Path> | This is used for recording a response file. The information is recorded in the destination file path specified.
-removeallfiles | This is used for removing the home directory after de-installation of all the components. This is used with the -deinstall flag.
-removeAllPatches | This is used for removing all interim patches from the home.
-silent | This is used for silent mode operations. The input can be a response file or a list of command line variable value pairs. You can use the -responsefile flag along with this flag.
-updateNodeList | This is used for updating node list for this home in the Oracle Universal Installer inventory. You can pass the ORACLE_HOME, LOCAL_NODE, and CLUSTER_NODES session variable when using this flag
-waitforcompletion | This is used on Windows platform. The command console will wait for Oracle Universal Installer to exit, if you specify this flag.
-nobackground | This is used to specify to Oracle Universal Installer not to show background images.
-noclusterEnabled | This flag indicates that no cluster nodes are specified.
-noconsole | This is used for suppressing the display of messages to the console.
-nowarningonremovefiles | This is used to disable the warning message before removal of home directory. This is used with the -deinstall flag.
-nowait | This is used on Windows platform. Specifies not to wait for the user to hit Enter on the console after the task (installation, etc.) is complete.
-formCluster | This is used to install the Oracle Clusterware in order to form the cluster.
-remotecp <Path> | This flag can only be passed on UNIX platforms. This is used only for cluster installs. This flag specifies the path to the remote copy program on the local cluster node. For example, the path for scp is /usr/bin/scp.
-remoteshell <Path> | This flag can only be passed on UNIX platforms. This is used only for cluster installs. This specifies the path to the remote shell program on the local cluster node. For example, the path for ssh is /usr/bin/ssh.

## Command Line Variables Available in Oracle Universal Installer

The following table lists the command line variables available in Oracle Universal Installer:

Table C-2 Command line variables in Oracle Universal Installer

Command Line Variable | Description
--- | ---
INVENTORY_LOCATION | This is used to specify the inventory location.
ORACLE_HOME | This is used to specify the ORACLE HOME location.
ORACLE_HOME_NAME | This is used to specify the ORACLE HOME name in the target machine.
ORACLE_HOME_KEY | This is used to specify the ORACLE HOME key name. This is used only on Windows platform.
ORACLE_HOME_FOLDER | This is used to specify the ORACLE HOME folder name. This is used only on Windows platform.
ORACLE_HOME_SERVICE | This is used to specify the ORACLE HOME service name. This is used only on Windows platform.
ANONYMOUS_LOGIN | This is used to specify anonymous login.
LOGIN_NAME | This is used to specify the login name.
PASSWORD | This is used to specify the password.
LOGIN_CATEGORY | This is used to specify the login category.
UNIX_GROUP_NAME | This is used to specify the group name on UNIX platform.
FROM_LOCATION | This is used to specify the location from where the component gets installed. This is the complete path to the products.xml file.
FROM_LOCATION_CD_LABEL | This is used to specify the label of the CD where the products.xml file resides in a multi-CD installation. The label can be found in the file disk label in the directory where the products.xml resides.
COMPONENT_LANGUAGES | This is used to specify the languages in which the components will be installed.
SELECTED_LANGUAGES | This is used to specify the selected languages.
SELECTED_PLATFORMS | This is used to specify the selected platforms.
TOPLEVEL_COMPONENT | This is used to specify the top level component to be installed in the current session.
ToplevelComp | This is used to specify the top level component id.
INSTALL_TYPE | This is used to specify the installation type of the components.
SHOW_SPLASH_SCREEN | This is used to specify whether the splash screen will be displayed in the current session. Set to true if the splash screen needs to be displayed.
SHOW_WELCOME_PAGE | This is used to specify whether the welcome screen will be displayed in the current session. Set to true if the Welcome page in the Oracle Universal Installer needs to be displayed.
SHOW_ROOTSH_CONFIRMATION | Set to true if the confirmation dialogue asking to run the root.sh script in the Oracle Universal Installer needs to be shown. This flag can only be passed on UNIX platforms.
SHOW_EXIT_CONFIRMATION | This is used to specify whether to display the confirmation dialogue for exiting the Oracle Universal Installer. Set to true for exit.
SHOW_CUSTOM_TREE_PAGE | This is used to specify if the custom tree page in the Oracle Universal Installer needs to be shown. Use this page to select/de-select dependencies. This page appears only in the custom installation type
SHOW_COMPONENT_LOCATIONS_PAGE | This is used to specify if the components location page in the Oracle Universal Installer needs to be shown. This page appears if there are products whose installed directory can be changed. Set the value to false to prevent user from specifying an alternate directory.
SHOW_NODE_SELECTION_PAGE | This is used to specify if the node selection page should be shown to the user.
SHOW_SUMMARY_PAGE | This is used to specify if the summary page in the Oracle Universal Installer needs to be shown. The summary page shows the list of components that need to be installed in this session.
SHOW_INSTALL_PROGRESS_PAGE | This is used to specify if the installation progress page in the Oracle Universal Installer needs to be shown. This page shows the current status in the installation.
SHOW_REQUIRED_CONFIG_TOOL_PAGE | This is used to specify if the required config assistants page in Oracle Universal Installer needs to be shown.This page shows the list of required configuration assistants that are part of this installation. It shows the status of each assistant, including any failures with detailed information on why it failed.
SHOW_CONFIG_TOOL_PAGE | This is used to specify if the config assistants page in Oracle Universal Installer needs to be shown. This page shows the list of configuration assistants that are part of this installation and are configured to launch automatically. It shows the status of each assistant, including any failures with detailed information on why it failed.
SHOW_RELEASE_NOTES | This is used to specify if the release notes of this installation need to be shown at the end of installation. This dialog can be launched from the End of Installation page and shows the list of release notes available for the products just installed. This also requires the variable SHOW_END_SESSION_PAGE variable to be set to true.
SHOW_END_OF_INSTALL_MSGS | This is used to specify if the text on end of installation screen is to be shown. The text is always available under <Oracle_Home>/install/readme.txt.
SHOW_END_SESSION_PAGE | This is used to specify if the end of session page in Oracle Universal Installer needs to be shown. This page shows if the installation is successful or not.
SHOW_XML_PREREQ_PAGE | This is used to specify whether or not to show the prereq page.
NEXT_SESSION | This is used to specify if you want users to go back to the File Locations page for another installation. This flag also needs to be set to true in order to process another response file (see NEXT_SESSION_RESPONSE). This argument is used for chain installs.
NEXT_SESSION_ON_FAIL | This is used to specify the next session response. Set to true to allow users to invoke another session even if current installation session has failed. This flag is only relevant if NEXT_SESSION is set to true. This argument is used for chain installs.
NEXT_SESSION_RESPONSE | This is used to specify the full path of the next session's response file. If only a file name is specified, the response file is retrieved from the <TEMP>/oraInstall directory. This variable is active only if NEXT_SESSION is set to true. This argument is used for chain installs.
LOCATION_FOR_DISK | This is the name used to specify the complete path to the other disks.
DEINSTALL_LIST | This is used to specify the list of components to be removed during a de-install session. This argument is used with the -deinstall flag.
SHOW_DEINSTALL_CONFIRMATION | This is used to specify the de-install confirmation. Set to true if de-install confirmation is needed during a de-install session. This argument is used with the -deinstall flag.
SHOW_DEINSTALL_PROGRESS | This is used to specify the de-install progress. Set to true if de-install progress is needed during a de-install session. This argument is used with the -deinstall flag.
REMOVE_HOMES | This is used to specify the list of the homes to be removed during a de-install session. Each home is represented by its full path. This argument is used with the -deinstall flag.
CLUSTER_NODES | This is used to specify the cluster node names selected by the user for installation.
CLUSTER_NEW_NODES | This is used to specify the new cluster nodes to be used for node addition.
REMOTE_NODES | This is used to specify the remote nodes
REMOTE_CLEAN_MACHINES | This is used to specify the remote nodes which do not have an installation inventory set up
LOCAL_NODE | This is used to specify the local node
EXISTING_REMOTE_NODES | This is used to specify the remote nodes on which the current home is already installed on.
CRS | This is used to specify whether the Oracle home is an Oracle Clusterware home or not
CLUSTER_NEW_PRIVATE_NODE_NAMES | This is used to specify the private node names for the new nodes that are used for node addition.
CLUSTER_NEW_HOST_NAMES | This is used to specify the host names for the new cluster nodes.
CLUSTER_NEW_NODE_NUMBERS | This is used to specify the node numbers of the new cluster nodes
CLUSTER_NEW_VIRTUAL_HOSTNAMES | This is used to specify the virtual host names for the new cluster nodes.
ACCEPT_LICENSE_AGREEMENT | This is used to specify the license agreement status. By setting this variable to true, you are accepting the license agreement.
REGISTRATION_KEYWORD | This is used to specify the registration keyword value. This can be obtained from the URL specified in Product Registration Page
RESTART_SYSTEM | This is used to specify whether to restart the system or not. Set to true to allow automatic restart of the system, if set to false then installer will exit without restarting, no exit confirmation dialog is shown
RESTART_REMOTE_SYSTEM | This is used to specify whether to restart the remote system or not. Set to true to allow automatic restart of the remote system, if set to false then installer will not restart remote systems, no exit confirmation dialog is shown
SESSION_MODE | This session variable holds the current Oracle Universal Installer execution mode. e.g., "Install" for an install and/or de-install session, or "Clone" for a cloning (home fix-up) session.
LOG_LOCATION | This is used to specify the log file location. This variable specifies the directory that contains the log files generated during installation. This directory is located within the Oracle home.
IGNORE_PREREQ | This is used to specify whether to skip the pre-requisite checks or not. Set to true to continue component installation even when pre-requisite check fails.
ORACLE_HOSTNAME | This is used to specify the host name of the system as set by the user.
PREREQ_CONFIG_LOCATION | This is used to specify the location where pre-requisite config files are available
PREREQ_LOG_LOCATION | This is used to specify the prereqs log location where pre-requisite results will be generated.
PREREQ_ENTRY_POINT | This is used to specify the log location where pre-requisite results will be generated.
ROOTSH_STATUS | This is used to specify the root.sh status - whether root.sh is required/before config or after config. This flag is used only on UNIX platforms.
SHOW_CUSTOM_ROOTSH_MESSAGE | This is used to specify the custom message shown for the root_sh dialogue. This flag is used only on UNIX platforms.
ROOTSH_LOCATION | This is used to specify the Root.sh location. By default it is set to OH\root.sh. This flag is used only on UNIX platforms.
USE_PREREQ_CHECKER | This is used to specify if the prereq checker is to be used during the installation or not. The value for this variable is set based on the value in the oraparam.ini.
USE_OLD_INSTALL_PREREQS | This is used to specify if old style system prereqs are to be enabled in the installation scripts. The PRE_REQUISITE code should use this variable to determine which checks can be turned on or off. The value of this variable is set based on the value in the Oraparam.ini.
SHOW_NEXT_SESSION_PROGRESS | This is used to specify if progress dialog will be shown during the setup of next session or not. This flag is used in chain installs.
NEXT_SESSION_PROGRESS_TITLE | This is used to specify the title of the progress dialog shown during the setup of next session. This flag is used in chain installs.
NEXT_SESSION_PROGRESS_TEXT | This is used to specify the text above the progress bar in the progress dialog shown during the setup of next session. This flag is used in chain installs.